home *** CD-ROM | disk | FTP | other *** search
/ Ian & Stuart's Australian Mac 1993 September / September 93.iso / Archives / Applications / Graphics / graph / Graf.1.4.3 / Readme 1.4.3 < prev   
Encoding:
Text File  |  1992-06-09  |  18.4 KB  |  300 lines  |  [TEXT/GRA1]

  1. Preliminary notes: v 1.4.2
  2.  
  3. Disclaimer: These notes are a guide only, they do not constitute a user manual.
  4.  
  5. “If this program proves useful to anyone out there then fine, if not then that's fine too.”
  6.  
  7. New for 1.4.2/1.4.3
  8.  
  9. • System 7.0 Publish and Subscribe!  Allows for publication of plots and subscription of
  10. data.  By combining Auto redraw for plots and a new auto publish options, Graf can serve as
  11. a plotting facility to any program that can publish and subscribe.
  12. • Enabled the colour option for the marker symbols at last.  (They used to be stuck as black)
  13. • Resolved design problems with 'Header' data windows. The file name is nolonger suffixed
  14. with the '-Header' text.  The info box now displays tiny status icons that differentiate the Header
  15. files from normal data files.  This fixes problems with file names on disk.
  16. • Can operate in the background.  This is useful for publish/subscribe server setting and for
  17. future releases of Graf with Apple Event control.
  18. • Standardised the dialog button locations to suit the system 7.0 user interface guidelines.
  19. • New smoothing algorithm based on bezier curves to give a truely parametric smoothing.  This
  20. means that you can smooth a spiral if you really want to.
  21. • Faster columns allocation dialog, you can now jump forward and back by 6 columns at a time
  22. by clicking in the numbers part of the 'scrollbar'.  The click sound has been removed as well.
  23. • Plot page preview windoid.  Useful for Macs with small screens, this will reduce the need
  24. for scrolling around to check the page layout for big plots.
  25. • Changed Default Text and Defaul Plot mechanism.  You now need to place the default files
  26. in the system folder on the startup disk.  The preferences folder is not used to maintain System 6
  27. compatibility without undue coding complications.
  28. • Reorganised plot window menus. Overlays is now a submenu of a 'Special' menu which 
  29. includes the new page preview option.
  30. • Added cooler colour buttons/icons etc for those with colour macs.
  31. • Improved tearoff menus so that they don't tear off so easily.
  32. • Upgraded the line style menus to bring it in line with the style of the other tearoffs.
  33. • Fixed bug where last byte in data file was ignored (Thanks John)
  34. • Fixed colour menu so that the colour items remain coloured.
  35. • Finally fixed text scrolling (Applause!).
  36. • Many minor bug fixes, to numerous to mention (well, this is freeware)
  37.  
  38. New for 1.3.1/1.3.2
  39.  
  40. • Figured out 68000 mac  (Plus, SE etc) QuickDraw bug work around.  
  41. Stops crash on startup when using a default plot.  I should never have sold my mac plus....
  42. • Also for 68000 mac owners, speed up in text input.
  43. • Fixed crash upon quitting without saving any modified files
  44.  
  45. IMPORTANT: New for 1.3.0
  46.  
  47. • Fixed a bug when saving large files (ie Header windows) that would otherwise cause all
  48. but the first 28k to be missing from the saved file.  This may cause data to be lost.  Please
  49. stop using ANY version before 1.3.0.
  50. • Fixed a bug caused by cosmetic plotting bug fixes.... (see v1.2.6)
  51.  
  52. {Stuff about eariler versions deleted}
  53.  
  54. Introduction:
  55.  
  56. Graf is object oriented in the way it handles data and plots. This means that each set of data has the 
  57. information on how it wants to be plotted, and each plot has its own formatting information and a 
  58. list of data to plot.
  59.  
  60. This is implemented through popup menus, thus Graf requires at least System version 6.0.2 to 
  61. operate. It will of course operate with all newer versions.   It is system 7.0 friendly, 32 bit clean
  62. and compatible with all macs from the mac plus up to the Quadra 950.
  63.  
  64. There are two kinds of windows in Graf. The first it the data windows, such as this one, and the 
  65. other is the plot window type.  Each kind of window has its own popup menubar to set up the various 
  66. parameters needed for the final plotting.
  67.  
  68. Firstly, the data window menus:
  69.  
  70. • Marker: This menu allows the symbols and error bar styles to be set for the data points when 
  71. they are plotted. The current selection is shown on the menubar beside “Marker”. 
  72.  
  73. •Symbols: This menu graphicly shows the available symbols.
  74. This menu is a 'tearoff' just like some hypercard menus. Will stay around so long as the active 
  75. window is a data window (since plots don't have markers.)
  76.  
  77. •Size: This is the size of the enclosing box that the symbol is drawn in (the box is not drawn). The 
  78. “Other…” option uses the resource picture to show size changes graphicly. Note that when a high 
  79. resolution printer is used, the PICT format of symbol will automaticly take advantage of the higher 
  80. resolution and in general the symbols look best on the final output (where we want them to). 
  81.  
  82. •Errors: Graf allows for independent +Δx, -Δx, +Δy and -Δy errors. The first 6 options are 
  83. various styles of errors, from none to ovals, the last two options are vector plot options, where 
  84. the Δx and Δy terms are not errors, but actually form a vector with the main data point. One 
  85. option has little arrow heads and the other is symmetrical about the data point and is bi directional.
  86. This menu is now a 'tearoff' just like some hypercard menus. Will stay around so long as the active 
  87. window is a data window (since plots don't have markers. 
  88.  
  89. •Line: This menu specifies the way in which data points are joined. The current selection is shown 
  90. on the menubar beside “Line” as a line in the selected style, and a small icon to show the joining 
  91. method. 
  92.  
  93. •Pensize: is the thickness of the pen in point/pixels, On the screen widths less than one are 
  94. displayed as one. On high resolution printouts the actual thickness asked for is used. 
  95.  
  96. •Pattern: shows the system list of patterns, to use in drawing the line. The 'plain' grays have 
  97. postscript grays substituted when printed, other bitmaps are copied. If you really want a different 
  98. pattern, then warm up ResEdit and make your own PAT# resource in Graf.... 
  99. This menu is now a 'tearoff' just like some hypercard menus. Will stay around so long as the active 
  100. window is a data window (since plots don't have patterns). 
  101.  
  102. •Style: determines the methods of joining points, from a simple straight line to no line at all. The 
  103. rectilinear methods are useful for discrete, binned data where the value corresponds to the centre, 
  104. right or left edge of the bin. The smoothed option is a parametric quadratic bezier curve 
  105. using the data points  and as off curve controls and data point mid points as on curve controls.
  106. This menu isa 'tearoff' just like some hypercard menus. Will stay around so long as the active 
  107. window is a data window (since plots don't have LineStyles of their own).
  108.  
  109. •Form Polygons: If this item is chosen, then the line segments will be grouped into macdraw style 
  110. polygons rather than simple groups. So, if you want a spline smoothing, then edit the plot with 
  111. macdraw, select the line and choose the smooth option...
  112.  
  113. •Setup: This is where the x,y and error columns are assigned, and any scaling or offsets are 
  114. applied. Once the columns and offsets are determined (or defaulted) then these plus the Marker and 
  115. Line settings constitute a 'setup'. With multicolumn data, it is often desirable to plot several 
  116. different pieces of information,in different styles, so each data window actually has a list of 
  117. setups, starting with the initial 
  118. '1 of 1' . New, independent settings can be defined by adding new setups to the list with the little 
  119. arrows. the single arrows navigate up and down the list, adding new setups if needed. The double 
  120. arrow is used to reduce the total list of setups.  When a data window is plotted, it is actually 
  121. plotted a number of times, once for each setup in the list.
  122.  
  123. •The 'Tabbed data' option refers to typical mac spreadsheet tab delimited data. Without this option 
  124. strings of tabs are regarded as as single column setting. When this options used then each tab 
  125. indicates a new column. This item is necessary for tabbed spreadsheets with missing entries in 
  126. some positions.
  127.  
  128. •Text: The data windows are text files, and behave like a very simple word processor (hence this 
  129. document). So each data has a Text menus for changing the appearance of the data only, this has no 
  130. effect on the plotting operations at all.
  131.  
  132. The data in the data windows is organised as follows:
  133.  
  134. •The data is in a 'free form' text style, unlike the more common cell or spreadsheet style. This has 
  135. a number of advantages and disadvantages: 
  136. •The best advantage is that virtually any TEXT document can be read in a view in a readable and 
  137. sensible manner. Special column separators and so on are not needed. 
  138. •The worst disadvantage is that manipulating columns of data is very difficult. Graf is NOT an 
  139. analysis program, and any spreadsheet like fiddling should be done before entering Graf. A 
  140. Multifinder setup with excel and Graf works very well, with Graf providing the high quality 
  141. graphics that Excel lacks. 
  142. • The data is still conceptually organised in columns, with the columns being defined on a line by 
  143. line basis. That is, columns only exist on lines that have columns of numbers, and any line can have 
  144. any number of columns from 0 up. 
  145. • Graf uses a fairly clever interpreter to get the information from the data. This means that 
  146. enormous data arrays are not needed, in fact only 6 binary numbers are needed (x,y,+Δx,-
  147. Δx,+Δy,-Δy) at any one time. It has also been introduced to the output from various makes of 
  148. computers and can handle data with line feeds or without for example. 
  149. • The following is a conceptual description of how Graf reads the data files:
  150. i) Check the first non-space character on a line,Column counter = 0, 
  151. ii) If it is a numerical character then goto 4 
  152. iii) Skip line and goto 1 
  153. iv) increment column counter 
  154. v) Read in characters until a non-numerical character or newline is encountered 
  155. vi) Form a number with the characters so far.The numbers that correspond to your column
  156. settings are plotted and the rest are skipped. 
  157. vii) read more characters, goto 2. 
  158. {this is VERY conceptual} 
  159.  
  160. •Put Simply: any line that doesn't begin with a number is skipped. Columns of numbers may be 
  161. separated by any non numerical characters. Columns are read along a line until the line runs out or 
  162. the  required columns have been read. Any time a required number fails to evaluate (ie a malformed 
  163. number or  missing columns, a value of zero is used, mostly so the problem is visible and 
  164. corrections can be applied).
  165. •Individual window may only contain ~32000 characters, If a large data file is read, Graf keeps 
  166. track of most of it, and only displays a header window. This header allows you to make any settings 
  167. for the data, but editing the header (which is only part of the data anyway) will have no effect on 
  168. the plotting. 
  169.  
  170. The plot windows menus:
  171. • The most important menu in the plot window is the “Data sets” menu. This is a dynamic, changing 
  172. menu that shows the list of available data to plot. By selecting data window with this menu, the plot 
  173. window accumulates the list of data to plot. When the draw button is pressed, this list is processes 
  174. sequentially, in the order they were selected. If a data window consists of a series of setups the 
  175. these are cycled through before the next data is processed. Each data set is plotted in the style 
  176. defined in the manner defined in their respective setups in their respective windows. 
  177.  
  178. •Axes: this menu defines the basic appearance of the plot. 
  179.  
  180. •Size refers to the size of the rectangular frame that the plot is drawn in. The dialog box that come 
  181. up is designed to work in pixels as this is the only way to be sure of the final result. There are x2 
  182. and /2 buttons for scaling up and down easily, useful for when you want to print at some sort of 
  183. reduction on your printer. 
  184. • Ticks: Tick spacing are in terms of the data units, tick lengths are in pixels. The Autoscale button 
  185. provides 'semi-automatic' scalings of ticks to the current range. A warning will appear if you 
  186. choose a ticks spacing that will produce hundreds of ticks, either redo the spacing or use the auto 
  187. scale option. 
  188. •Range: determines the data values that will be plotted. Data points outside this range will not be 
  189. plotted.  If all points fall out of range during a plot then a warning is given.
  190. •Scales: This is where you can choose normal, log-normal and log-log plotting, to various bases. 
  191. The data is “logged” and the plotted on normal linear axis, there are no silly uneven spaced ticks. 
  192. •Numbers etc: This section of the Axes menu determines the setting for the axes numbers!
  193. •Labels:This menu is the implementation of labelling in Graf. It provides for a title, x-axis label and 
  194. y axis rotated label. In addition a legend facility is available. For more fancy labelling, save the plot 
  195. and post edit it with a program like macdraw. 
  196. •Thickness: is the thickness of theframe and ticks in point/pixels, On the screen widths less than
  197. one are displayed as one. On high resolution printouts the actual thickness asked for is used. 
  198.  
  199. Each submenu give independent control over the content and style of each label. The dialog boxes 
  200. ask for a string (up to 40 chars) and a location (in pixels) for the label. The labels are centered on 
  201. the location The labels can be drawn or not drawn, and have an optional frame. 
  202.  
  203. The names used in the legend come from the columns setup for the data sets.  The lines/marker 
  204. styles are read from the data setups.
  205.  
  206. • Special: This menu contains a group of miscellaneous items. 
  207. • Preview…: This item brings up a small floating winowoid that displays the current plot and the
  208. number of pages needed to print it using the current page setup.  As the plot size and/or pagesetup
  209. change this window will resize to reflect the page layout.  It will not grow too large however and 
  210. should always remain a relatively small proportion of a 9" Mac screen in size.  You cannot 
  211. manipulate the plot layout with the windoid.
  212. •Overlays: this is a list of plot windows. This list is drawn in the current plot window before the 
  213. current plot is drawn. In this way multiple plots can be layed out on one page. In addition, Graf can 
  214. read any PICT file into a plot window, so some fancy background pictures could be used for your 
  215. plots.
  216.  
  217. •The Draw button: In general, drawing the data is a slow business, compared to the frame and axes 
  218. etc. So While all the plot formatting is redrawn automaticly, no data is plotted until the button is 
  219. pressed.  When there are few data points, this is no problem, and when there are many, it is much 
  220. easier to get everything just right and then plot the data last. 
  221.  
  222. The data plotting can be interrupted on a set by set basis. That is 'command - .' will stop the 
  223. current set being plotted, and the next set if any will be commenced. For a single set this will then 
  224. stop the plotting and for multiple sets, multiple interrupts may be needed. This was done to allow 
  225. finer control over the interruptions, particularly is you want to skip forward over sets to have a 
  226. look at how a later set will look. 
  227. During plotting, the data window being plotted is displayed in the bottom left 'information' box in 
  228. the plot window. A percentage shows how much of the file has been read (not how many data 
  229. points), in ten line  steps. With multiple setups, one file name will be shown with the setup counters 
  230. incrementing several times.
  231.  
  232. Graphical plot manipulation:
  233.  
  234. Frame:
  235. •A single-click-drag in the plot frame allows the user to reposition the frame, the frame etc will 
  236. be redrawn, but not the data. 
  237. •A double-click in the frame will bring up the size dialog. 
  238. •The bottom right corner of the frame is a resizing corner for clicking and dragging. Labels & 
  239. Legend: 
  240. •A single-click-drag in the labels allows the labels to be relocated. In a layered system, the labels 
  241. are on top of the data and frame. 
  242. •A double-click in a label will bring up the appropriate dialog. Ticks: 
  243. •A double-click in the lower x axis ticks or left y axis ticks will bring up the range dialog. 
  244. •A option-double-click in the lower x axis ticks or left y axis ticks will bring up the ticks dialog.
  245.  
  246. Numbers:
  247. •A double-click in the numbers will bring up the numbers dialog.
  248.  
  249. General Notes:
  250.  
  251. The fine lines in Graf do not require page reduction for printing, a good result will come from 100% 
  252. page sizes. If you are attempting to make multiple line segments look smooth however, consider 
  253. drawing a large plot and reducing the printout, this reduces the quickdraw integer coordinate 
  254. rounding errors which depend on the resolution that the plot is drawn at. That is if you have 2000 
  255. pixels to choose from compared to 200 ,say, the a better accuracy will be achieved.
  256.  
  257. Graf knows what resolution the printer is using, so you do not have to use the precision bitmap 4% 
  258. reduction etc, and a 25% reduction really maps to 300 dpi on the laserwriter. The page breaks for 
  259. the plot, using the current page setup are drawn in 3 pixel wide stripped lines, these lines are NOT 
  260. printed. These lines are centred on the page break.
  261.  
  262. The normal menubar menus are standard menus, plus a Data window to display data windows, and a 
  263. plot menu for finding plot windows. The “Hide” file option simply makes the window invisible, the 
  264. window still exists and can be plotted etc, the appropriate menu will redisplay the windows.
  265.  
  266. In principle there are no limits to the number of windows, size of data or plots etc in Graf, however 
  267. the current version will only handle upto ~256 windows and 100 column data and any number of 
  268. setups! This is all limited by your available memory, but graf will work in ~400K of RAM with 10 
  269. or so windows. Check the about… item for your current free memory. If you get low on memory 
  270. then you will be given the opportunity to save your work and quit. Try the usual methods to 
  271. increase your RAM available for the program if this happens.
  272.  
  273. General Setup:
  274.  
  275. Default settings can be defined by setting up a window in the desired format and saving it under a 
  276. special name. For default text settings name the file 'Default Text' (case is important), and use 
  277. 'Default Plot' for a default plot setting. When new blank windows are required, Graf will look for 
  278. these files in the same directory as Graf, and in the system folder. If they are found then they will 
  279. be loaded in as Untitled-x or Plot-x (where x is a number). If they are not found then internal 
  280. defaults are used.
  281.  
  282. The Preferences menu item 'Auto draw plots' is the same as using the draw button all the time. This 
  283. is only really useful for small data sets when drawing is quick.
  284.  
  285. The Show Floats item will only be available once a floating palette/menu has been torn off. The 
  286. show /hide operations will only apply to the currently 'torn' menus.
  287.  
  288. bugs to:
  289.  
  290. Ralph S. Sutherland. 
  291. 9 Mt Stromlo Observatory
  292. Private Bag Weston P.O. 2611
  293. A.C.T.
  294. Australia
  295.  
  296. email:
  297.  
  298. ralph@madras.anu.edu.au or ralph@merlin.anu.edu.au
  299.  
  300.